Summary

Fully Qualified Name:	Laminas\Cache\Storage\Adapter\FilesystemOptions
Extends:	AdapterOptions

Description

Methods

Name	Description	Defined By
__construct()	Constructor	FilesystemOptions
__get()	Get a configuration property	AbstractOptions
__isset()	Test if a configuration property is null	AbstractOptions
__set()	Set a configuration property	AbstractOptions
__unset()	Set a configuration property to NULL	AbstractOptions
getCacheDir()	Get cache dir	FilesystemOptions
getClearStatCache()	Get clear stat cache	FilesystemOptions
getDirLevel()	Get dir level	FilesystemOptions
getDirPermission()	Get permission to create directories on unix systems	FilesystemOptions
getFileLocking()	Get file locking	FilesystemOptions
getFilePermission()	Get permission to create files on unix systems	FilesystemOptions
getKeyPattern()	Get key pattern	AdapterOptions
getNamespace()	Get namespace	AdapterOptions
getNamespaceSeparator()	Get namespace separator	FilesystemOptions
getNoAtime()	Get no atime	FilesystemOptions
getNoCtime()	Get no ctime	FilesystemOptions
getReadable()	If reading data from cache enabled.	AdapterOptions
getSuffix()	Get the suffix for cache files	FilesystemOptions
getTagSuffix()	Get the suffix for tag files	FilesystemOptions
getTtl()	Get time to live.	AdapterOptions
getUmask()	Get the umask to create files and directories on unix systems	FilesystemOptions
getWritable()	If writing data to cache enabled.	AdapterOptions
setAdapter()	Adapter using this instance	AdapterOptions
setCacheDir()	Set cache dir	FilesystemOptions
setClearStatCache()	Set clear stat cache	FilesystemOptions
setDirLevel()	Set dir level	FilesystemOptions
setDirPermission()	Set permission to create directories on unix systems	FilesystemOptions
setFileLocking()	Set file locking	FilesystemOptions
setFilePermission()	Set permission to create files on unix systems	FilesystemOptions
setFromArray()	{@inheritdoc}	AdapterOptions
setKeyPattern()	Set key pattern	AdapterOptions
setNamespace()	Set namespace.	AdapterOptions
setNamespaceSeparator()	Set namespace separator	FilesystemOptions
setNoAtime()	Set no atime	FilesystemOptions
setNoCtime()	Set no ctime	FilesystemOptions
setReadable()	Enable/Disable reading data from cache.	AdapterOptions
setSuffix()	Set the suffix for cache files	FilesystemOptions
setTagSuffix()	Set the suffix for cache files	FilesystemOptions
setTtl()	Set time to live.	AdapterOptions
setUmask()	Set the umask to create files and directories on unix systems	FilesystemOptions
setWritable()	Enable/Disable writing data to cache.	AdapterOptions
toArray()	Cast to array	AdapterOptions

Method Details

__construct()

Constructor

Parameter Name	Type	Description
$options	array|\Traversable|null

Returns: \FilesystemOptions

__get()

Get a configuration property

Parameter Name	Type	Description
$key	string

Returns: mixed

__isset()

Test if a configuration property is null

Parameter Name	Type	Description
$key	string

Returns: bool

__set()

Set a configuration property

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: void

__unset()

Set a configuration property to NULL

Parameter Name	Type	Description
$key	string

Returns: void

getCacheDir()

Get cache dir

Returns: null|string

getClearStatCache()

Get clear stat cache

Returns: bool

getDirLevel()

Get dir level

Returns: int

getDirPermission()

Get permission to create directories on unix systems

Returns: bool|int

getFileLocking()

Get file locking

Returns: bool

getFilePermission()

Get permission to create files on unix systems

Returns: bool|int

getKeyPattern()

Get key pattern

Returns: string

getNamespace()

Get namespace

Returns: string

getNamespaceSeparator()

Get namespace separator

Returns: string

getNoAtime()

Get no atime

Returns: bool

getNoCtime()

Get no ctime

Returns: bool

getReadable()

If reading data from cache enabled.

Returns: bool

getSuffix()

Get the suffix for cache files

Returns: string

getTagSuffix()

Get the suffix for tag files

Returns: \the $tagSuffix

getTtl()

Get time to live.

Returns: float

getUmask()

Get the umask to create files and directories on unix systems

Returns: bool|int

getWritable()

If writing data to cache enabled.

Returns: bool

setAdapter()

Adapter using this instance

Parameter Name	Type	Description
$adapter	\StorageInterface|null

Returns: \AdapterOptions Provides a fluent interface

setCacheDir()

Set cache dir

Parameter Name	Type	Description
$cacheDir	string

Returns: \FilesystemOptions Provides a fluent interface

setClearStatCache()

Set clear stat cache

Parameter Name	Type	Description
$clearStatCache	bool

Returns: \FilesystemOptions Provides a fluent interface

setDirLevel()

Set dir level

Parameter Name	Type	Description
$dirLevel	int

Returns: \FilesystemOptions Provides a fluent interface

setDirPermission()

Set permission to create directories on unix systems

Parameter Name	Type	Description
$dirPermission	bool|string|int	FALSE

Returns: \FilesystemOptions Provides a fluent interface

setFileLocking()

Set file locking

Parameter Name	Type	Description
$fileLocking	bool

Returns: \FilesystemOptions Provides a fluent interface

setFilePermission()

Set permission to create files on unix systems

Parameter Name	Type	Description
$filePermission	bool|string|int	FALSE

Returns: \FilesystemOptions Provides a fluent interface

setFromArray()

{@inheritdoc}

NOTE: This method was overwritten just to support prioritized properties {@link https://github.com/zendframework/zf2/issues/6381}

Parameter Name	Type	Description
$options	array|\Traversable|\AbstractOptions

Returns: \AbstractOptions Provides fluent interface

setKeyPattern()

Set key pattern

Parameter Name	Type	Description
$keyPattern	string

Returns: \AdapterOptions Provides a fluent interface

setNamespace()

Set namespace.

Parameter Name	Type	Description
$namespace	string

Returns: \AdapterOptions Provides a fluent interface

setNamespaceSeparator()

Set namespace separator

Parameter Name	Type	Description
$namespaceSeparator	string

Returns: \FilesystemOptions Provides a fluent interface

setNoAtime()

Set no atime

Parameter Name	Type	Description
$noAtime	bool

Returns: \FilesystemOptions Provides a fluent interface

setNoCtime()

Set no ctime

Parameter Name	Type	Description
$noCtime	bool

Returns: \FilesystemOptions

setReadable()

Enable/Disable reading data from cache.

Parameter Name	Type	Description
$readable	bool

Returns: \AdapterOptions Provides a fluent interface

setSuffix()

Set the suffix for cache files

Parameter Name	Type	Description
$suffix	string

Returns:

setTagSuffix()

Set the suffix for cache files

Parameter Name	Type	Description
$tagSuffix	string

Returns:

setTtl()

Set time to live.

Parameter Name	Type	Description
$ttl	int|float

Returns: \AdapterOptions Provides a fluent interface

setUmask()

Set the umask to create files and directories on unix systems

Note: On multithreaded webservers it's better to explicit set file and dir permission.

Parameter Name	Type	Description
$umask	bool|string|int	FALSE

Returns: \FilesystemOptions

setWritable()

Enable/Disable writing data to cache.

Parameter Name	Type	Description
$writable	bool

Returns: \AdapterOptions Provides a fluent interface

toArray()

Cast to array

Returns: array